Skip to content

docs: add Chrome extension example dataset guide for ClickStack#117

Open
mintlify[bot] wants to merge 1 commit into
mainfrom
mintlify/99b85dea
Open

docs: add Chrome extension example dataset guide for ClickStack#117
mintlify[bot] wants to merge 1 commit into
mainfrom
mintlify/99b85dea

Conversation

@mintlify
Copy link
Copy Markdown
Contributor

@mintlify mintlify Bot commented Jun 3, 2026

Summary

Ports ClickHouse/clickhouse-docs#6340 — new guide for instrumenting any site with the HyperDX Chrome extension for ClickStack session replay/RUM.

Changes

  • Added products/clickstack/example-datasets/chrome-extension.mdx (slug preserved: /use-cases/observability/clickstack/example-datasets/chrome-extension).
  • Converted Docusaurus admonitions/imports to Mintlify equivalents (<Info>, <Steps>/<Step>, Image snippet import).
  • Rewrote cross-links to match this repo's conventions:
    • /use-cases/observability/clickstack/session-replay/products/clickstack/features/session-replay
    • session-replay.md relative link → /products/clickstack/example-datasets/session-replay
    • /use-cases/observability/clickstack/getting-started/oss/products/clickstack/getting-started/oss
  • Registered the page in products/clickstack/navigation.json under Sample datasets, after session-replay.

Notes / ambiguity

  • The upstream PR references an image static/images/clickstack/chrome-extension/extension-config.png, but the image is not committed in the source PR. The <Image> line has been replaced with a TODO comment and a short prose description so the page renders cleanly. Once the asset lands upstream, add it to images/clickstack/chrome-extension/extension-config.png and restore the <Image> tag.
  • Removed Docusaurus-only frontmatter (sidebar_position, pagination_prev, pagination_next) that has no Mintlify equivalent.

Note

Low Risk
Documentation-only addition with a navigation entry; no runtime or security-sensitive code changes.

Overview
Adds a new Sample datasets guide that walks through using the HyperDX Chrome extension to inject the ClickStack Browser SDK on arbitrary sites for session replay and RUM, without changing the target app’s code.

The new chrome-extension.mdx page is written for Mintlify (<Info>, <Steps>, repo-style links to session replay, OSS getting started, and the browser SDK). Configuration UI screenshot is deferred with a TODO until images/clickstack/chrome-extension/extension-config.png exists. navigation.json lists the page under Sample datasets, after session replay.

Reviewed by Cursor Bugbot for commit 046a2bd. Bugbot is set up for automated code reviews on this repo. Configure here.

@mintlify
Copy link
Copy Markdown
Contributor Author

mintlify Bot commented Jun 3, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
ClickHouse-docs 🟢 Ready View Preview Jun 3, 2026, 9:42 PM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants